<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: JObject.html 878 2015-04-17 01:32:03Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import org.jsimpledb.core.ObjId;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>/**<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Interface implemented by {@link JSimpleDB} Java model objects.<a name="line.13"></a>
<span class="sourceLineNo">014</span> *<a name="line.14"></a>
<span class="sourceLineNo">015</span> * &lt;p&gt;<a name="line.15"></a>
<span class="sourceLineNo">016</span> * All {@link JSimpleDB} database objects are instances of runtime-generated sub-classes of user-provided Java model classes.<a name="line.16"></a>
<span class="sourceLineNo">017</span> * These generated subclasses will always implement this interface, providing convenient access to database operations.<a name="line.17"></a>
<span class="sourceLineNo">018</span> * Therefore, it is conveninent to declare Java model classes {@code abstract} and {@code implements JObject}.<a name="line.18"></a>
<span class="sourceLineNo">019</span> * However, this is not strictly necessary; all of the methods declared here ultimately delegate to one of the<a name="line.19"></a>
<span class="sourceLineNo">020</span> * {@link JTransaction} support methods.<a name="line.20"></a>
<span class="sourceLineNo">021</span> * &lt;/p&gt;<a name="line.21"></a>
<span class="sourceLineNo">022</span> *<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;p&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> * There are two types of {@link JObject}s: normal instances, which always reflect the state of the {@link JTransaction}<a name="line.24"></a>
<span class="sourceLineNo">025</span> * {@linkplain JTransaction#getCurrent associated} with the current thread, and "snapshot" instances that reflect<a name="line.25"></a>
<span class="sourceLineNo">026</span> * the state of their associated {@link SnapshotJTransaction}. Use {@link #isSnapshot} to distinguish if necessary<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Use {@link #copyIn copyIn()} and {@link #copyOut copyOut()} to copy data between normal and snapshot transactions.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;/p&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * The {@link #getTransaction} method returns the transaction associated with an instance. For a normal instance,<a name="line.31"></a>
<span class="sourceLineNo">032</span> * this is just the {@link JTransaction} {@linkplain JTransaction#getCurrent associated} with the current thread;<a name="line.32"></a>
<span class="sourceLineNo">033</span> * if there is no such transaction, an {@link IllegalStateException} is thrown. For a "snapshot" instance,<a name="line.33"></a>
<span class="sourceLineNo">034</span> * {@link #getTransaction} always returns the corresponding {@link SnapshotJTransaction}.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;/p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>public interface JObject {<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>    /**<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * Get this instance's unique JSimpleDB object identifier.<a name="line.40"></a>
<span class="sourceLineNo">041</span>     *<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * &lt;p&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * This method always succeeds.<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * &lt;/p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span>     *<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * @return unique database identifier for this instance<a name="line.46"></a>
<span class="sourceLineNo">047</span>     */<a name="line.47"></a>
<span class="sourceLineNo">048</span>    ObjId getObjId();<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>    /**<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * Get this instance's current schema version. Does not change this instance's schema version.<a name="line.51"></a>
<span class="sourceLineNo">052</span>     *<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * @return the schema version of this instance<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * @throws org.jsimpledb.core.DeletedObjectException<a name="line.54"></a>
<span class="sourceLineNo">055</span>     *  if this object does not exist in the {@link JTransaction} associated with this instance<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * @throws IllegalStateException if this is not a snapshot instance and there is no {@link JTransaction}<a name="line.56"></a>
<span class="sourceLineNo">057</span>     *  associated with the current thread<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * @throws org.jsimpledb.core.StaleTransactionException<a name="line.58"></a>
<span class="sourceLineNo">059</span>     *  if this is not a snapshot instance and the transaction associated with the current thread is no longer usable<a name="line.59"></a>
<span class="sourceLineNo">060</span>     */<a name="line.60"></a>
<span class="sourceLineNo">061</span>    int getSchemaVersion();<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span>    /**<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * Get this instance's associated {@link JTransaction}.<a name="line.64"></a>
<span class="sourceLineNo">065</span>     *<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * &lt;p&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * If this is a regular database instance, this returns the {@link JTransaction}<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * {@linkplain JTransaction#getCurrent associated} with the current thread. Otherwise, this instance<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * is a snapshot instance and this method returns the associated {@link SnapshotJTransaction}.<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * &lt;/p&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span>     *<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * @return the {@link JTransaction} that contains this instance's field state<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * @throws IllegalStateException if this is not a snapshot instance and there is no {@link JTransaction}<a name="line.73"></a>
<span class="sourceLineNo">074</span>     *  associated with the current thread<a name="line.74"></a>
<span class="sourceLineNo">075</span>     */<a name="line.75"></a>
<span class="sourceLineNo">076</span>    JTransaction getTransaction();<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span>    /**<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * Delete this instance, if it exists, in this instance's associated transaction.<a name="line.79"></a>
<span class="sourceLineNo">080</span>     *<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * &lt;p&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * See {@link org.jsimpledb.core.Transaction#delete Transaction.delete()} for details on secondary deletions from<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * {@link org.jsimpledb.core.DeleteAction#DELETE} and {@link org.jsimpledb.annotation.JField#cascadeDelete}.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * &lt;/p&gt;<a name="line.84"></a>
<span class="sourceLineNo">085</span>     *<a name="line.85"></a>
<span class="sourceLineNo">086</span>     * @return true if instance was deleted, false if it did not exist<a name="line.86"></a>
<span class="sourceLineNo">087</span>     * @throws IllegalStateException if this is not a snapshot instance and there is no {@link JTransaction}<a name="line.87"></a>
<span class="sourceLineNo">088</span>     *  associated with the current thread<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * @throws org.jsimpledb.core.StaleTransactionException<a name="line.89"></a>
<span class="sourceLineNo">090</span>     *  if the transaction associated with the current thread is no longer usable<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @throws org.jsimpledb.core.ReferencedObjectException if the object is referenced by some other object<a name="line.91"></a>
<span class="sourceLineNo">092</span>     *  through a reference field configured for {@link org.jsimpledb.core.DeleteAction#EXCEPTION}<a name="line.92"></a>
<span class="sourceLineNo">093</span>     */<a name="line.93"></a>
<span class="sourceLineNo">094</span>    boolean delete();<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>    /**<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * Determine whether this instance still exists in its associated transaction.<a name="line.97"></a>
<span class="sourceLineNo">098</span>     *<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * @return true if instance exists, otherwise false<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * @throws IllegalStateException if this is not a snapshot instance and there is no {@link JTransaction}<a name="line.100"></a>
<span class="sourceLineNo">101</span>     *  associated with the current thread<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * @throws org.jsimpledb.core.StaleTransactionException<a name="line.102"></a>
<span class="sourceLineNo">103</span>     *  if this is not a snapshot instance and the transaction associated with the current thread is no longer usable<a name="line.103"></a>
<span class="sourceLineNo">104</span>     */<a name="line.104"></a>
<span class="sourceLineNo">105</span>    boolean exists();<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span>    /**<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * Determine whether this instance is a normal instance or is a "snapshot" instance associated<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * with a {@link SnapshotJTransaction}.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     *<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * @return true if instance is a snapshot instance<a name="line.111"></a>
<span class="sourceLineNo">112</span>     */<a name="line.112"></a>
<span class="sourceLineNo">113</span>    boolean isSnapshot();<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span>    /**<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * Recreate a deleted instance, if it does not exist, in its associated transaction.<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * The fields of a recreated object are set to their initial values. If the object already exists, nothing changes.<a name="line.117"></a>
<span class="sourceLineNo">118</span>     *<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * @return true if instance was recreated, false if it already existed<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * @throws IllegalStateException if this is not a snapshot instance and there is no {@link JTransaction}<a name="line.120"></a>
<span class="sourceLineNo">121</span>     *  associated with the current thread<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * @throws org.jsimpledb.core.StaleTransactionException<a name="line.122"></a>
<span class="sourceLineNo">123</span>     *  if this is not a snapshot instance and the transaction associated with the current thread is no longer usable<a name="line.123"></a>
<span class="sourceLineNo">124</span>     */<a name="line.124"></a>
<span class="sourceLineNo">125</span>    boolean recreate();<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span>    /**<a name="line.127"></a>
<span class="sourceLineNo">128</span>     * Add this instance to the validation queue for validation in its associated transaction.<a name="line.128"></a>
<span class="sourceLineNo">129</span>     *<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * &lt;p&gt;<a name="line.130"></a>
<span class="sourceLineNo">131</span>     * The actual validation will occur either during {@link JTransaction#commit}<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * or at the next invocation of {@link JTransaction#validate}, whichever occurs first.<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * &lt;/p&gt;<a name="line.133"></a>
<span class="sourceLineNo">134</span>     *<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * @throws org.jsimpledb.core.DeletedObjectException<a name="line.135"></a>
<span class="sourceLineNo">136</span>     *  if this object does not exist in the {@link JTransaction} associated with this instance<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * @throws IllegalStateException if transaction commit is already in progress<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * @throws IllegalStateException if this is not a snapshot instance and there is no {@link JTransaction}<a name="line.138"></a>
<span class="sourceLineNo">139</span>     *  associated with the current thread<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * @throws org.jsimpledb.core.StaleTransactionException<a name="line.140"></a>
<span class="sourceLineNo">141</span>     *  if this is not a snapshot instance and the transaction associated with the current thread is no longer usable<a name="line.141"></a>
<span class="sourceLineNo">142</span>     */<a name="line.142"></a>
<span class="sourceLineNo">143</span>    void revalidate();<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>    /**<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * Update the schema version of this instance, if necessary, so that it matches the schema version<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * of its associated transaction.<a name="line.147"></a>
<span class="sourceLineNo">148</span>     *<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * &lt;p&gt;<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * If a version change occurs, matching {@link org.jsimpledb.annotation.OnVersionChange &amp;#64;OnVersionChange}<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * methods will be invoked prior to this method returning.<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * &lt;/p&gt;<a name="line.152"></a>
<span class="sourceLineNo">153</span>     *<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @return true if the object's schema version was changed, false if it was already updated<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * @throws org.jsimpledb.core.DeletedObjectException<a name="line.155"></a>
<span class="sourceLineNo">156</span>     *  if this object does not exist in the {@link JTransaction} associated with this instance<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * @throws IllegalStateException if this is not a snapshot instance and there is no {@link JTransaction}<a name="line.157"></a>
<span class="sourceLineNo">158</span>     *  associated with the current thread<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * @throws org.jsimpledb.core.StaleTransactionException<a name="line.159"></a>
<span class="sourceLineNo">160</span>     *  if this is not a snapshot instance and the transaction associated with the current thread is no longer usable<a name="line.160"></a>
<span class="sourceLineNo">161</span>     */<a name="line.161"></a>
<span class="sourceLineNo">162</span>    boolean upgrade();<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span>    /**<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * Copy this instance, and other instances it references, into a (possibly) different {@link JTransaction}.<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * This is a more general method; see {@link #copyIn copyIn()} and {@link #copyOut copyOut()} for more common<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * and specific use cases.<a name="line.167"></a>
<span class="sourceLineNo">168</span>     *<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * &lt;p&gt;<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * This method will copy this object's fields into the object with ID {@code target} (or this instance's object ID if<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * {@code target} is null) in the {@code dest} transaction, overwriting any previous values there, along with all other<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * objects reachable from this instance through any of the specified {@linkplain ReferencePath reference paths} (including<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * intermediate objects visited). This instance will first be {@link #upgrade}ed if necessary.<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * If {@code target} (or any other referenced object) already exists in {@code dest}, it will have its schema version<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * updated first, if necessary, otherwise it will be created.<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * Any {@link org.jsimpledb.annotation.OnCreate &amp;#64;OnVersionChange}, {@link org.jsimpledb.annotation.OnCreate &amp;#64;OnCreate},<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * and {@link org.jsimpledb.annotation.OnCreate &amp;#64;OnChange} methods will be notified accordingly as usual (in {@code dest});<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * however, for {@link org.jsimpledb.annotation.OnCreate &amp;#64;OnCreate} and<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * {@link org.jsimpledb.annotation.OnCreate &amp;#64;OnChange}, the annotation must have {@code snapshotTransactions = true}<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * if {@code dest} is a {@link SnapshotJTransaction}.<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * &lt;/p&gt;<a name="line.181"></a>
<span class="sourceLineNo">182</span>     *<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * &lt;p&gt;<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * The two transactions must be compatible in that for any schema versions encountered, those schema versions<a name="line.184"></a>
<span class="sourceLineNo">185</span>     * must be identical in both transactions.<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * &lt;/p&gt;<a name="line.186"></a>
<span class="sourceLineNo">187</span>     *<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * &lt;p&gt;<a name="line.188"></a>
<span class="sourceLineNo">189</span>     * Circular references are handled properly: if an object is encountered more than once, it is not copied again.<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * The {@code copyState} parameter can be used to keep track of objects that have already been copied and/or traversed<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * along some reference path (however, if an object is marked as copied in {@code copyState} and is traversed, but does not<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * actually already exist in {@code dest}, an exception is thrown).<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * For a "fresh" copy operation, pass a newly created {@code CopyState}; for a copy operation that is a continuation<a name="line.193"></a>
<span class="sourceLineNo">194</span>     * of a previous copy, {@code copyState} may be reused.<a name="line.194"></a>
<span class="sourceLineNo">195</span>     * &lt;/p&gt;<a name="line.195"></a>
<span class="sourceLineNo">196</span>     *<a name="line.196"></a>
<span class="sourceLineNo">197</span>     * &lt;p&gt;<a name="line.197"></a>
<span class="sourceLineNo">198</span>     * Note: if {@code target} is not equal to this instance's object ID, and through one of the {@code refPaths} there<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * is a circular reference back to this instance, then that reference is copied as-is (i.e., it is not copied<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * onto {@code target}).<a name="line.200"></a>
<span class="sourceLineNo">201</span>     * &lt;/p&gt;<a name="line.201"></a>
<span class="sourceLineNo">202</span>     *<a name="line.202"></a>
<span class="sourceLineNo">203</span>     * &lt;p&gt;<a name="line.203"></a>
<span class="sourceLineNo">204</span>     * Warning: if two threads attempt to copy objects between the same two transactions at the same time<a name="line.204"></a>
<span class="sourceLineNo">205</span>     * but in opposite directions, deadlock could result.<a name="line.205"></a>
<span class="sourceLineNo">206</span>     * &lt;/p&gt;<a name="line.206"></a>
<span class="sourceLineNo">207</span>     *<a name="line.207"></a>
<span class="sourceLineNo">208</span>     * @param dest destination transaction for copies<a name="line.208"></a>
<span class="sourceLineNo">209</span>     * @param target target object ID in {@code dest} onto which to copy this instance's fields, or null for this instance<a name="line.209"></a>
<span class="sourceLineNo">210</span>     * @param copyState tracks which indirectly referenced objects have already been copied<a name="line.210"></a>
<span class="sourceLineNo">211</span>     * @param refPaths zero or more reference paths that refer to additional objects to be copied<a name="line.211"></a>
<span class="sourceLineNo">212</span>     * @return the copied version of this instance in {@code dest}<a name="line.212"></a>
<span class="sourceLineNo">213</span>     * @throws org.jsimpledb.core.DeletedObjectException<a name="line.213"></a>
<span class="sourceLineNo">214</span>     *  if this object does not exist in the {@link JTransaction} associated with this instance<a name="line.214"></a>
<span class="sourceLineNo">215</span>     *  (no exception is thrown however if an indirectly referenced object does not exist unless it is traversed)<a name="line.215"></a>
<span class="sourceLineNo">216</span>     * @throws org.jsimpledb.core.DeletedObjectException if an object in {@code copied} is traversed but does not actually exist<a name="line.216"></a>
<span class="sourceLineNo">217</span>     * @throws IllegalStateException if this is not a snapshot instance and there is no {@link JTransaction}<a name="line.217"></a>
<span class="sourceLineNo">218</span>     *  associated with the current thread<a name="line.218"></a>
<span class="sourceLineNo">219</span>     * @throws org.jsimpledb.core.SchemaMismatchException<a name="line.219"></a>
<span class="sourceLineNo">220</span>     *  if the schema corresponding to this object's version is not identical in both the {@link JTransaction}<a name="line.220"></a>
<span class="sourceLineNo">221</span>     *  associated with this instance and {@code dest} (as well for any referenced objects)<a name="line.221"></a>
<span class="sourceLineNo">222</span>     * @throws IllegalArgumentException if {@code dest}, {@code copied}, or {@code refPaths} is null<a name="line.222"></a>
<span class="sourceLineNo">223</span>     * @throws IllegalArgumentException if any path in {@code refPaths} is invalid<a name="line.223"></a>
<span class="sourceLineNo">224</span>     * @see #copyIn copyIn()<a name="line.224"></a>
<span class="sourceLineNo">225</span>     * @see #copyOut copyOut()<a name="line.225"></a>
<span class="sourceLineNo">226</span>     * @see JTransaction#copyTo(JTransaction, JObject, ObjId, CopyState, String[]) JTransaction.copyTo()<a name="line.226"></a>
<span class="sourceLineNo">227</span>     */<a name="line.227"></a>
<span class="sourceLineNo">228</span>    JObject copyTo(JTransaction dest, ObjId target, CopyState copyState, String... refPaths);<a name="line.228"></a>
<span class="sourceLineNo">229</span><a name="line.229"></a>
<span class="sourceLineNo">230</span>    /**<a name="line.230"></a>
<span class="sourceLineNo">231</span>     * Snapshot this instance and other instances it references.<a name="line.231"></a>
<span class="sourceLineNo">232</span>     *<a name="line.232"></a>
<span class="sourceLineNo">233</span>     * &lt;p&gt;<a name="line.233"></a>
<span class="sourceLineNo">234</span>     * This method will copy this object and all of its fields, along with all other objects reachable through<a name="line.234"></a>
<span class="sourceLineNo">235</span>     * any of the specified {@linkplain ReferencePath reference paths} into the {@link SnapshotJTransaction}<a name="line.235"></a>
<span class="sourceLineNo">236</span>     * {@linkplain JTransaction#getSnapshotTransaction corresponding} to this instance's associated transaction<a name="line.236"></a>
<span class="sourceLineNo">237</span>     * (including intermediate objects visited). This instance will first be {@link #upgrade}ed if necessary.<a name="line.237"></a>
<span class="sourceLineNo">238</span>     * If any object already exists there, it will be overwritten, otherwise it will be created.<a name="line.238"></a>
<span class="sourceLineNo">239</span>     * {@link org.jsimpledb.annotation.OnCreate &amp;#64;OnCreate} and {@link org.jsimpledb.annotation.OnCreate &amp;#64;OnChange}<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * notifications will be delivered accordingly; however, the annotation must have {@code snapshotTransactions = true}.<a name="line.240"></a>
<span class="sourceLineNo">241</span>     * &lt;/p&gt;<a name="line.241"></a>
<span class="sourceLineNo">242</span>     *<a name="line.242"></a>
<span class="sourceLineNo">243</span>     * &lt;p&gt;<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * Normally this method would only be invoked on a regular database {@link JObject}.<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * The returned object will always be a snapshot {@link JObject}.<a name="line.245"></a>
<span class="sourceLineNo">246</span>     * &lt;/p&gt;<a name="line.246"></a>
<span class="sourceLineNo">247</span>     *<a name="line.247"></a>
<span class="sourceLineNo">248</span>     * &lt;p&gt;<a name="line.248"></a>
<span class="sourceLineNo">249</span>     * This is a convenience method, and is equivalent to invoking:<a name="line.249"></a>
<span class="sourceLineNo">250</span>     * &lt;blockquote&gt;&lt;code&gt;<a name="line.250"></a>
<span class="sourceLineNo">251</span>     * this.copyTo(this.getTransaction().getSnapshotTransaction(), null, new CopyState(), refPaths);<a name="line.251"></a>
<span class="sourceLineNo">252</span>     * &lt;/code&gt;&lt;/blockquote&gt;<a name="line.252"></a>
<span class="sourceLineNo">253</span>     *<a name="line.253"></a>
<span class="sourceLineNo">254</span>     * @param refPaths zero or more reference paths that refer to additional objects to be copied<a name="line.254"></a>
<span class="sourceLineNo">255</span>     * @return the snapshot {@link JObject} copy of this instance<a name="line.255"></a>
<span class="sourceLineNo">256</span>     * @throws org.jsimpledb.core.DeletedObjectException<a name="line.256"></a>
<span class="sourceLineNo">257</span>     *  if this object does not exist in the {@link JTransaction} associated with this instance<a name="line.257"></a>
<span class="sourceLineNo">258</span>     *  (no exception is thrown however if an indirectly referenced object does not exist)<a name="line.258"></a>
<span class="sourceLineNo">259</span>     * @throws IllegalStateException if this is not a snapshot instance and there is no {@link JTransaction}<a name="line.259"></a>
<span class="sourceLineNo">260</span>     *  associated with the current thread<a name="line.260"></a>
<span class="sourceLineNo">261</span>     * @throws IllegalArgumentException if any path in {@code refPaths} is invalid<a name="line.261"></a>
<span class="sourceLineNo">262</span>     * @see #copyIn copyIn()<a name="line.262"></a>
<span class="sourceLineNo">263</span>     */<a name="line.263"></a>
<span class="sourceLineNo">264</span>    JObject copyOut(String... refPaths);<a name="line.264"></a>
<span class="sourceLineNo">265</span><a name="line.265"></a>
<span class="sourceLineNo">266</span>    /**<a name="line.266"></a>
<span class="sourceLineNo">267</span>     * Copy this instance and other instances it references into the transaction associated with the current thread.<a name="line.267"></a>
<span class="sourceLineNo">268</span>     *<a name="line.268"></a>
<span class="sourceLineNo">269</span>     * &lt;p&gt;<a name="line.269"></a>
<span class="sourceLineNo">270</span>     * This method will copy this object and all of its fields, along with all other objects reachable through any of the<a name="line.270"></a>
<span class="sourceLineNo">271</span>     * specified {@linkplain ReferencePath reference paths} into the {@link JTransaction}<a name="line.271"></a>
<span class="sourceLineNo">272</span>     * {@linkplain JTransaction#getCurrent associated} with the current thread (including intermediate objects visited).<a name="line.272"></a>
<span class="sourceLineNo">273</span>     * If any object already exists in the current thread's transaction, it will be overwritten, otherwise it will be created.<a name="line.273"></a>
<span class="sourceLineNo">274</span>     * {@link org.jsimpledb.annotation.OnCreate &amp;#64;OnCreate} and {@link org.jsimpledb.annotation.OnCreate &amp;#64;OnChange}<a name="line.274"></a>
<span class="sourceLineNo">275</span>     * notifications will be delivered accordingly.<a name="line.275"></a>
<span class="sourceLineNo">276</span>     * &lt;/p&gt;<a name="line.276"></a>
<span class="sourceLineNo">277</span>     *<a name="line.277"></a>
<span class="sourceLineNo">278</span>     * &lt;p&gt;<a name="line.278"></a>
<span class="sourceLineNo">279</span>     * Normally this method would only be invoked on a snapshot {@link JObject}.<a name="line.279"></a>
<span class="sourceLineNo">280</span>     * The returned object will always be a regular database {@link JObject}.<a name="line.280"></a>
<span class="sourceLineNo">281</span>     * &lt;/p&gt;<a name="line.281"></a>
<span class="sourceLineNo">282</span>     *<a name="line.282"></a>
<span class="sourceLineNo">283</span>     * &lt;p&gt;<a name="line.283"></a>
<span class="sourceLineNo">284</span>     * This is a convenience method, and is equivalent to invoking:<a name="line.284"></a>
<span class="sourceLineNo">285</span>     * &lt;blockquote&gt;&lt;code&gt;<a name="line.285"></a>
<span class="sourceLineNo">286</span>     * this.copyTo(JTransaction.getCurrent(), null, new CopyState(), refPaths)<a name="line.286"></a>
<span class="sourceLineNo">287</span>     * &lt;/code&gt;&lt;/blockquote&gt;<a name="line.287"></a>
<span class="sourceLineNo">288</span>     *<a name="line.288"></a>
<span class="sourceLineNo">289</span>     * @param refPaths zero or more reference paths that refer to additional objects to be copied<a name="line.289"></a>
<span class="sourceLineNo">290</span>     * @return the regular database copy of this instance<a name="line.290"></a>
<span class="sourceLineNo">291</span>     * @throws org.jsimpledb.core.DeletedObjectException<a name="line.291"></a>
<span class="sourceLineNo">292</span>     *  if this object does not exist in the {@link JTransaction} associated with this instance<a name="line.292"></a>
<span class="sourceLineNo">293</span>     *  (no exception is thrown however if an indirectly referenced object does not exist)<a name="line.293"></a>
<span class="sourceLineNo">294</span>     * @throws IllegalStateException if this is not a snapshot instance and there is no {@link JTransaction}<a name="line.294"></a>
<span class="sourceLineNo">295</span>     *  associated with the current thread<a name="line.295"></a>
<span class="sourceLineNo">296</span>     * @throws org.jsimpledb.core.SchemaMismatchException<a name="line.296"></a>
<span class="sourceLineNo">297</span>     *  if the schema corresponding to this object's version is not identical in both transactions<a name="line.297"></a>
<span class="sourceLineNo">298</span>     * @throws IllegalArgumentException if any path in {@code refPaths} is invalid<a name="line.298"></a>
<span class="sourceLineNo">299</span>     * @see #copyOut copyOut()<a name="line.299"></a>
<span class="sourceLineNo">300</span>     */<a name="line.300"></a>
<span class="sourceLineNo">301</span>    JObject copyIn(String... refPaths);<a name="line.301"></a>
<span class="sourceLineNo">302</span>}<a name="line.302"></a>
<span class="sourceLineNo">303</span><a name="line.303"></a>




























































</pre>
</div>
</body>
</html>
